home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc / OpenDoc Development / Debugging Support / OpenDoc™ Source Code / Storage / Bento / CM / CMAPIErr.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-08-28  |  17.7 KB  |  203 lines  |  [TEXT/MPS ]
  1. /*
  2.     File:        CMAPIErr.h
  3.  
  4.     Contains:    Container Manager Error Code Numbers and Their Meaning
  5.  
  6.     Written by:    Ira L. Ruben
  7.  
  8.     Owned by:    Ed Lai
  9.  
  10.     Copyright:    © 1991 - 1994 by Apple Computer, Inc., all rights reserved.
  11.  
  12.     Change History (most recent first):
  13.  
  14.          <2>     8/26/94    EL        #1181622 Ownership update.
  15.  
  16.     To Do:
  17. */
  18.  
  19. /* (use tabs = 2 to view this file correctly) */
  20. /*---------------------------------------------------------------------------*
  21.  |                                                                           |
  22.  |                           <<< CM_API_Errno.h >>>                          |
  23.  |                                                                           |
  24.  |           Container Manager Error Code Numbers and Their Meaning          |
  25.  |                                                                           |
  26.  |                               Ira L. Ruben                                |
  27.  |                                 12/06/91                                  |
  28.  |                                                                           |
  29.  |                  Copyright Apple Computer, Inc. 1991-1992                 |
  30.  |                           All rights reserved.                            |
  31.  |                                                                           |
  32.  *---------------------------------------------------------------------------*
  33.  
  34.  This header contains all the error number codes passed to the error handler.  The error
  35.  handler function address MUST be passed to CMStartSession() which MUST be called before
  36.  any other Container Manager routine.  It should have the following prototype:
  37.  
  38.                      void anErrorHandler(CMErrorNbr errorNumber, ...)
  39.  
  40.  The "..." is for possible error message string inserts which are a function of the error
  41.  number.
  42.  
  43.  In the list of error code definitions below, the comment shows the meaning of the error
  44.  code.  The "^n"s (^0, ^1, etc.) in the comments show where the inserts would go.  ^0 is
  45.  the first insert, ^1 the second, and so on.
  46.  
  47.  The Container Manager API provides routines to allow an error handler to convert the
  48.  error number and its associated insert to the messages shown in the comments.  The API
  49.  routine CMVGetErrorString() is the primary routine which a error handler would probably
  50.  use to convert the error code and inserts to a message string. Other routines are
  51.  provided.  See API.h and Container Manager API documentation for further details.
  52. */
  53.  
  54.  
  55. #ifndef __CM_API_ERRNO__
  56. #define __CM_API_ERRNO__
  57.  
  58.  
  59.                                                  /*-----------------------------------*
  60.                                                     | The Container Manager Error Codes |
  61.                                                     *-----------------------------------*/
  62.                                                      
  63. /* The comments for each of these error codes correspond to the intended meaning.  A ^n    */
  64. /* in the comment indicates a insert.  ^0 is the first insert, ^1 the second, and so on.*/
  65.  
  66. #define CM_err_GenericMessage            0    /* ^0                                                                                                                                                                    */
  67. #define CM_err_BadTocSize                  1    /* TOC index table size out of range (^0 <= range <= ^1)                                                            */
  68. #define CM_err_NoSession                    2    /* Unable to allocate session (task) global data                                                                            */
  69. #define CM_err_NoHandler                  3    /* Cannot allocate space for handler for type "^0"                                                                        */
  70. #define CM_err_BadWriteUse                4    /* Cannot do a CMOpenNewContainer(...^0...) with useFlags set for update-in-place            */
  71. #define CM_err_NoContainer              5    /* Cannot allocate CCB space for type "^0"                                                                                        */
  72. #define CM_err_UndefMetaHandler      6    /* Metahandler was not defined for type "^0"                                                                                    */
  73. #define CM_err_HandlerError              7    /* Allocation problem while looking up handler for type "^0"                                                    */
  74. #define CM_err_NullMetaPtr              8    /* Null metahandler pointer for type "^0"                                                                                            */
  75. #define CM_err_UndefRoutine              9    /* Handler routine(s) missing for operation type(s): ^0                                                                */
  76. #define CM_err_NoTOC                         10    /* Cannot allocate TOC for container "^0"                                                                                            */
  77. #define CM_err_BadReadUse              11    /* Cannot do a CMOpenContainer(..."^0"...) with useFlags set for ^1                                        */
  78. #define CM_err_BadMagicBytes         12    /* Invalid magic byte sequence in label for container "^0" - expected "^1", got "^2""    */
  79. #define CM_err_BadVersion                 13    /* Invalid version fields in label for container "^0" - expected ^1.^2, got ^3.^4"        */
  80. #define CM_err_BadTOCRead                 14    /* Incorrect byte length read while reading TOC for container "^0"                                        */
  81. #define CM_err_NoObjEntry                 15    /* Cannot allocate space for TOC object entry for container "^0"                                            */
  82. #define CM_err_MultDef                      16    /* Multiple definition for TOC object ^0 for container "^1"                                                        */
  83. #define CM_err_NoPropEntry              17    /* Cannot allocate space for TOC property entry for container "^0"                                        */
  84. #define CM_err_BadContinue              18    /* Invalid continued value (inconsistent types) in container "^0"                                            */
  85. #define CM_err_NoValueEntry              19 /* Cannot allocate space for TOC value entry for container "^0"                                                */
  86. #define CM_err_BadOffset                  20    /* Invalid offset or value (^0, ^1) for TOC value entry for container "^2"                         */
  87. #define CM_err_UndefObjects              21    /* There is (are) ^0 undefined object(s) in container "^1"                                                        */
  88. #define CM_err_NoStrValue                  22    /* Cannot allocate space for constant value in container "^0"                                                    */
  89. #define CM_err_DupBaseType               23    /* Cannot add dup base type "^0" to type "^1" in container "^2"                                                */
  90. #define CM_err_BadTOCWrite              24    /* Incorrect byte length written while writing TOC for "^0"                                                        */
  91. #define CM_err_NotGlobalName          25 /* Have global name tied to value of wrong type in containter "^0"                                        */
  92. #define CM_err_BadGNameWrite          26    /* Incorrect byte length written while writing global name "^0" in container "^1"            */
  93. #define CM_err_DupGlobalName          27    /* Duplicate global name definition for "^0" in container "^1"                                                */
  94. #define CM_err_MultGlblNames          28    /* Object ^0 alread defined -- trying to redefine it for "^1" (container "^2")                */
  95. #define CM_err_NoGlobalName           29    /* Cannot allocate space for global name "^0" in container "^1"                                                */
  96. #define CM_err_NoGNameLoad               30    /* Cannot allocate space for global name during load in container "^0"                                */
  97. #define CM_err_BadGNameRead              31    /* Incorrect byte length read while reading global name in container "^0"                            */
  98. #define CM_err_NotGName                      32    /* Invalid global name string read in container "^0"                                                                    */
  99. #define CM_err_BadType                      33 /* Invalid ^0 type passed to ^1 for container "^2"                                                                        */
  100. #define CM_err_2Containers              34    /* Objects not in same containers (containers "^0" and "^1")                                                    */
  101. #define CM_err_3Containers              35    /* Objects not in same containers (containers "^0", "^1", and "^2")                                        */
  102. #define CM_err_MissingMinIDSeed     36    /* Min ID seed value missing in TOC object 1 in container "^0"                                                */
  103. #define CM_err_MissingTOCObj          37    /* TOC object ID 1 missing in TOC in container "^0"                                                                        */
  104. #define CM_err_NotConverting          38    /* Cannot use CMDefineValueData except for converting container "^0"                                    */
  105. #define CM_err_BadDefineData          39    /* Attempt to define offset (^0) out of range in container "^1"                                                */
  106. #define CM_err_BadValue                      40    /* Attempt to use a deleted value    in container "^0"                                                                        */
  107. #define CM_err_BadObject                  41    /* Attempt to use a deleted object in container "^0"                                                                    */
  108. #define CM_err_BadContainer              42    /* Container for ^0 ("^1") does not belong to the container being used ("^2")                    */
  109. #define CM_err_NoValue                      43    /* No value defined for object ID ^0, property "^1" in container "^2"                                    */
  110. #define CM_err_HasValue                      44    /* Cannot set a (sub)value to an already defined value (container "^0")                                */
  111. #define CM_err_AlreadyReleased1     45    /* Attempting to release a value already completely released in container "^0"                */
  112. #define CM_err_NotReleased             46    /* A dynamic value has not been fully released in container "^0"                                            */
  113. #define CM_err_MissingFreeTotal     47    /* Total free space value missing in TOC object 1 in container "^0"                                        */
  114. #define CM_err_DupType                      48    /* Attempt to insert two values with the same type (^0) in container "^1"                            */
  115. #define CM_err_HasNoValue                  49    /* No value defined for CMReadValueData in container "^0"                                                            */
  116. #define CM_err_BadWrite                      50 /* Write error writing to container "^0"                                                                                            */
  117. #define CM_err_CantWriteGlbl          51    /* Cannot write to a global name in container "^0"                                                                        */
  118. #define CM_err_Offset2Big                  52    /* Write/insert offset (^0) beyond end of a value in container "^1"                                        */
  119. #define CM_err_Internal1                  53    /* Internal error! Unknown flags setting (0x^0)                                                                                */
  120. #define CM_err_MissingIDSeed          54    /* ID seed value missing in TOC object 1 in container "^0"                                                        */
  121. #define CM_err_AmbiguousType          55    /* ^0 object is ambiguous in container "^1"                                                                                        */
  122. #define CM_err_TypeNotGlobal          56 /* ^0 object is not for a global name in container "^1"                                                                */
  123. #define CM_err_MissingFreeList     57    /* Internal error - empty free list for property in container "^0"                                        */
  124. #define CM_err_NoNewValueHandler 58    /* A "new value" handler is not defined for type "^0"                                                                    */
  125. #define CM_err_UndefReference         59    /* Object ID ^0 from a reference is undefined in container "^1"                                                */
  126. #define CM_err_BadObjectKind          60    /* Invalid kind of object -- expected ^0 in container "^1"                                                        */
  127. #define CM_err_WriteIllegal1         61    /* Cannot write to a container ("^0") opened for reading                                                            */
  128. #define CM_err_WriteIllegal2          62    /* Attempt to write to a protected object in container "^0"                                                        */
  129. #define CM_err_ReadIllegal              63    /* Cannot read from a container ("^0") opened for writing                                                            */
  130. #define CM_err_MissingSize              64    /* Size value missing in TOC object 1 in container "^0"                                                                */
  131. #define CM_err_BadSize                      65    /* Inconsistent size values between container label and TOC (container "^0")                    */
  132. #define CM_err_Internal2                   66    /* Internal error! TOC offset to offset/size value not found in container "^0"                */
  133. #define CM_err_CantDelete1              67    /* Attempt to delete to a protected object in container "^0"                                                    */
  134. #define CM_err_CantDelete2              68    /* Attempt to delete to a property with a protected value in container "^0"                        */
  135. #define CM_err_CantDelete3              69    /* Attempt to delete to a protected value in container "^0"                                                        */
  136. #define CM_err_StillOpen                  70    /* Container "^0" is still open at session close time                                                                    */
  137. #define CM_err_EmptyRead                  71    /* Cannot read from an empty embedded container value (container "^0")                                */
  138. #define CM_err_NoEmbedding              72    /* Cannot allocate space to save embedding status while opening container "^0"                */
  139. #define CM_err_BadGenNbr                  73    /* Invalid generation number (^0) passed to ^1 (container "^2")                                                */
  140. #define CM_err_NoRef                          74    /* Connot allocate space for an object reference in container "^0"                                        */
  141. #define CM_err_CantGetBase              75    /* CMGetBaseValue() may only be called from a dynamic value handler in container "^0"    */
  142. #define CM_err_MultTypeProp              76    /* Attempt to register a ^0 name (^1) in container "^2" -- already defined as a ^3        */
  143. #define CM_err_NotSameMode              77    /* Embedded container ("^0") must be opened in same mode as its parent ("^1")                    */
  144. #define CM_err_CantDelete4              78    /* Cannot delete a value currently in use in container "^0"                                                        */
  145. #define CM_err_MissingHandler         79    /* Memory allocator and dealocator handlers must be supplied                                                    */
  146. #define CM_err_NoMissingBuffer     80    /* Unable to allocate private temporary buffer while opening type "^0"                                */
  147. #define CM_err_MoveIllegal              81    /* Cannot move a value in a container ("^0") not opened for writing                                        */
  148. #define CM_err_DeleteIllegal         82    /* Attempt to delete ^0 in a container ("^1") not opened for writing                                    */
  149. #define CM_err_BadDefineType          83    /* Attempt to define additional data for a immediate value in container "^0"                    */
  150. #define CM_err_NoDynExtensions     84    /* Cannot allocate space for TOC dynamic value entry for type "^0" in container "^1"    */
  151. #define CM_err_HandlerRecursed     85    /* Attempt to use dynamic value handler for ^0() recursively in container "^1"                */
  152. #define CM_err_BadRealValue             86    /* Invalid base ("real") value passed to ^0() in container "^1"                                                */
  153. #define CM_err_NoMetahandler         87    /* A value operations metahandler is not defined for type "^0" in container "^1"            */
  154. #define CM_err_NotDynValue             88    /* A "use value" metahandler did not create a dynamic value in container "^0"                    */
  155. #define CM_err_NoGlobalTable          89    /* Cannot allocate globally unique name table for container "^0"                                            */
  156. #define CM_err_BadMetaSpec             90    /* Invalid metadata format specification (%^0) for type "^1" in container "^2"                */
  157. #define CM_err_NoDeletesList          91    /* Internal error - empty "deletes" list for property in container ^0                                    */
  158. #define CM_err_NoDataPacket              92    /* Cannot allocate space for data packet for type "^0" in container "^1"                            */
  159. #define CM_err_BaseRelAttempted     93    /* A dynamic value release handler attempted to release its base in container "^0"        */
  160. #define CM_err_NoDynMetahandler     94    /* "Use value" handler for type "^0" in container "^1" MUST return a metahandler            */
  161. #define CM_err_MissingTotalSize  95    /* Total container size value missing in TOC object 1 in container "^0"                                */
  162. #define CM_err_Internal3                   96    /* Internal error! TOC offset to container value not found in container "^0"                    */
  163. #define CM_err_AmbiguousUseFlags 97    /* Ambiguous updating useFlags passed to CMOpenNewContainer(..."^0"...) - ^1                    */
  164. #define CM_err_NoTypeHandler         98    /* Dynamic value type handler not defined for updating in container "^0"                            */
  165. #define CM_err_NotDynamicValue     99    /* Dynamic value in container "^0" not created to access target for updating                    */
  166. #define CM_err_NoMetaDataHandler 100/* A "metadata" handler is not defined for type "^0"                                                                    */
  167. #define CM_err_NoDataBuffer              101/* Cannot allocate space for data I/O buffer in container ^0                                                    */
  168. #define CM_err_BadUpdateRead         102/* Incorrect byte length read while reading updates in container ^0                                        */
  169. #define CM_err_BadUpdateWrite         103/* Write error while writing updates in container ^0                                                                    */
  170. #define CM_err_Internal4                 104/* Internal error! End-of-updates signal not detected in container ^0                                    */
  171. #define CM_err_Internal5                 105/* Internal error! TOC offset to updates TOC subsection not found in container ^0            */
  172. #define CM_err_NoNewValuesTOC          106/* "New values" TOC offset/size missing in TOC object 1 in container ^0                                */
  173. #define CM_err_wrappedIDs                 107/* Too many objects in container "^0" or next user object ID > 0xFFFFFFFF                            */
  174. #define CM_err_NoTouchedEntry         108/* Cannot allocate space for recording updating operation in container ^0                            */
  175. #define CM_err_NoUpdateObject       109/* Container ^0 updating -- cannot find a object ID ^1 to be ^2                                                */
  176. #define CM_err_NoUpdateProperty  110/* Container ^0 updating -- cannot find a property ID ^1 in object ID ^2 to be ^3            */
  177. #define CM_err_BadUpdateControl     111/* Container ^0 updating -- unknown control byte read (0x^1, during ^2)                                */
  178. #define CM_err_NoUpdateType              112/* Container ^0 updating -- cannot find value (type ID ^1) in object ^2, property ^3    */
  179. #define CM_err_UndefUpdateObject 113/* Container ^0 updating -- cannot find ^1 (ID ^2) to use in ^3                                                */
  180. #define CM_err_UpdateBadGenNbr     114/* Container ^0 updating -- invalid generation number (^1)                                                        */
  181. #define CM_err_BadInsertData         115/* Container ^0 updating -- bad updating info (0 segment insert encountered)                    */
  182. #define CM_err_BadInsertOffset     116/* Container ^0 updating -- insert offset (^1) beyond end of a value                                    */
  183. #define CM_err_CantRepImmediate     117/* Container ^0 updating -- attempt to replace non-immediate with immediate                        */
  184. #define CM_err_CantRepBaseType     118/* Container ^0 updating -- attempt to replace non-base type value with a base type        */
  185. #define CM_err_CantReference         119/* Value and referenced object not in the same containers (containers "^0" and "^1")    */
  186. #define CM_err_GloblaNameError     120/* Allocation problem while looking up global name "^0" in container "^1"                            */
  187. #define CM_err_FlushErr                     121/* Error detected in flushing output while closing container ^0                                                */
  188. #define CM_err_CantDelete5              122/* Cannot delete an object with unreleased dynamic values in use in container "^0"        */
  189. #define CM_err_NoTOCBuffer             123/* Cannot allocate space for TOC I/O buffer in container "^0"                                                    */
  190. #define CM_err_BadTOCCode                 124/* Invalid TOC code read (0x^0) from TOC in container "^1"                                                        */
  191. #define CM_err_TOCoutOfSync             125/* TOC reading out-of-sync (trying to read across buffer boundary) in container "^0"    */
  192. #define CM_err_TOCParseErr1             126/* TOC "parse" error - expected object ID, got 0x^0 in container "^1"                                    */
  193. #define CM_err_TOCParseErr2             127/* TOC "parse" error - got 0x^0 at an unexpected time in container "^1"                                */
  194. #define CM_err_Unsupported1             128/* 8-byte offset in container "^0" are not supported in this implementation                        */
  195. #define CM_err_CantDelete6              129/* Cannot delete an object currently in use in container "^1"                                                    */
  196. #define CM_err_AlreadyReleased2     130/* Attempting to release an object already completely released in container "^0"            */
  197. #define CM_err_BadRefRead                   131/* Read error while reading references in container ^0                                                                */
  198. #define CM_err_Internal6                 132/* Internal error! Missing reference property or value in container "^0"                            */
  199. #define CM_err_ZeroRefKey                 133/* Attempt to use a CMReference key of 0 in container "^0"                                                        */
  200. #define CM_err_NoRefShadowList     134/* Cannot allocate space to record reference in container "^0"                                                */
  201.  
  202. #endif
  203.